ODF Builder is a small application that will build ODF and the sample parts.
Table of Contents
-------------------------
• Why Rebuild ODF?
• Usage
• Notes
Why Rebuild ODF?
ODF Builder is a small application that builds ODF and the sample parts. ODF is provided pre-built, but there are certain situations in which you may need to rebuild it: if you want correct symbol files, if you need to change the exception handling mechanism, or if you have changed the framework to fix any bugs.
Correct symbol files? Yes, the symbol files have full path names to the source code. Your hard drive and folders will have different names than our build machine, so to produce symbol files that are correct for your machine you must do a rebuild. Once you have correct symbol files you won’t have to deal with that pesky “Where is file so-and-so?” dialog.
Exception handling? See the 'ODF vs. Native Exceptions & RTTI' document.
Fix any Bugs? Alas, we do find bugs after we ship. Usually we discuss them on the ODF-Interest mailing list (odf-interest@cilabs.org) and the ODF web page (www.devtools.apple.com/odf/); after you've fixed source code or replaced source files you will of course need to rebuild ODF (and your part).
Usage
Configuration and Architecture: You must check at least one option in both the Configuration and Architecture sections. If you want to, you can check all of them and let your computer build all night (it would build Debug PPC, Debug 68K, Release PPC and Release 68K).
Layers: These checkboxes allow you rebuild only portions of ODF. Generally, however, you will want to rebuild all of it. If you are not doing Cyberdog development you turn off Internet. Note that Bitmap and CyberStarter are both Cyberdog-savvy, so you should leave it on if you want to rebuild either of those two parts.
Examples: Each example has its own About document listing its features. All the examples are supplied pre-built, but you may wish to build debug versions so you can inspect their behavior in a debugger.
The Special menu contains items which probably won’t be important to you; we use them internally. Some that you might care about are:
“Skip JPEG Library”: The IJG JPEG library is supplied pre-built, and without sources. The About document in the JPEG folder (in Bitmap) tells you where to get the source code, should you wish to rebuild it, but it's not necessary unless you wish to debug it.
“Use CW Exceptions & RTTI…”: Use this item to switch all of ODF to using CodeWarrior’s built-in exception handling (this will affect all projects in the layers and examples for the checked configuration and architecture). This is the default as shipped, so you don't need to do it unless you switched to emulated exceptions.
“Use ODF Exceptions & RTTI…”: Use this item to switch all of ODF to using emulated exceptions (this will affect all projects in the layers and examples for the checked configuration and architecture). We don’t recommend this since CodeWarrior has perfectly good native exceptions. See the ODF & Emulated Exceptions Engineering document for details.
Notes
ODF Builder must remain in the same folder as your ODF folder.
If for some reason you have multiple versions of ODF, you should use the ODF Builder from each folder to build that version.
You must have the Scriptable Finder installed. If you don't have the "Finder Scripting Extension" (in your Extensions folder) then ODF Builder won’t work (it will put up an alert in this case). You should be able to install it by running the System installer and checking "AppleScript".
